doc: add Rust toolchain general install instructions#63426
Open
MikeMcC399 wants to merge 1 commit into
Open
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
build
MikeMcC399
force-pushed
the
rust-install-instructions
branch
from
a114673 to
47c1e91
Compare
4 tasks
legendecas
approved these changes
May 19, 2026
richardlau
reviewed
May 19, 2026
richardlau
approved these changes
May 19, 2026
richardlau
added
commit-queue-squash
aduh95
reviewed
May 19, 2026
Comment on lines
+240
to
+241
| * A Rust toolchain if [Building Node.js with Temporal support](#building-nodejs-with-temporal-support) | ||
| is required (enabled by default starting in Node.js 26) |
Contributor
There was a problem hiding this comment.
Suggested change
| * A Rust toolchain if [Building Node.js with Temporal support](#building-nodejs-with-temporal-support) | |
| is required (enabled by default starting in Node.js 26) | |
| * A Rust toolchain if [building Node.js with `Temporal` support](#building-nodejs-with-temporal-support) | |
| (auto-detect by default as of Node.js 26.0.0). |
Contributor
Author
There was a problem hiding this comment.
The text "enabled by default in Node.js 26" is used elsewhere and in the release notes.
auto-detect works for Linux, however currently there seems to be an issue for Windows. See #63451
So I would defer making this change until it is confirmed for all operating systems.
aduh95
reviewed
May 19, 2026
aduh95
reviewed
May 19, 2026
aduh95
reviewed
May 19, 2026
aduh95
removed
the
author ready
MikeMcC399
commented
May 20, 2026
aduh95
reviewed
May 20, 2026
MikeMcC399
commented
May 20, 2026
RafaelGSS
approved these changes
May 20, 2026
Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Co-Authored-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
MikeMcC399
force-pushed
the
rust-install-instructions
branch
from
1f2b8da to
095da94
Compare
Contributor
Author
|
Squashed and rebased |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs: #63225
Situation
It does not provide any guidance on how to install in this section.
Building Node.js on supported platforms does not yet mention Rust
BUILDING > Unix and macOS also does not yet cover Rust
BUILDING > Windows Prerequisites already provides Rust toolchain installation instructions for Windows, with an additional PR build,win: add Rust toolchain automated configuration Windows #63381 for automated configuration currently pending
Change
Add link:
Install Rust
to the documentation sections:
Describe alternate use of distro packages
rustandcargoNotes
By default, Install Rust installs in a per-user configuration.
Platform advice may differ depending on the use-case. A local developer's system is probably best served by using a downloaded
rustup. A build-and-test CI system may alternatively prefer to install distro specificrustup/rust/cargopackages.Node.js 26 requires a minimum Rust toolchain version 1.82. Some older distros package incompatible versions. For example,
Debian 12 (bookworm / oldstable) offers version 1.63, whereas Debian 13 (trixie / stable) offers the compatible Rust toolchain version 1.85.
Backporting
This PR is applicable to Node.js >=26 only and should not be backported to earlier release lines. (It does have a reference to Node.js 25, however this is EOL in a few days, so backporting would not be relevant.)